#  Copyright 2021 Collate
#  Licensed under the Apache License, Version 2.0 (the "License");
#  you may not use this file except in compliance with the License.
#  You may obtain a copy of the License at
#  http://www.apache.org/licenses/LICENSE-2.0
#  Unless required by applicable law or agreed to in writing, software
#  distributed under the License is distributed on an "AS IS" BASIS,
#  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
#  See the License for the specific language governing permissions and
#  limitations under the License.
"""
Base local reader
"""
from abc import ABC, abstractmethod


class ReadException(Exception):
    """
    To be raised by any errors with the read calls
    """


class Reader(ABC):
    @abstractmethod
    def read(self, path: str) -> str:
        """
        Given a string, return a string
        """
        raise NotImplementedError("Missing read implementation")
